Dmitry Shalnoff's Git Repository - RGBW Controller/blob - README.md

   1 # RGB(W) LED Interplay Medium dendrite module (for ESP8266)
   2
   3 This is IM denrite module (remote wifi network device) created for [Interplay Medium™](https://interplaymedium.org) project.
   4
   5 ![Interplay Medium RGB(W) LED Dendrite](https://repository.interplaymedium.org/RGBW%20Controller/IM_RGBW_LED_dendrite.jpeg)
   6
   7 ## Pinouts
   8
   9 For LEDs be sure to add MOSFETs and current limiting resistors appropriately. Wiring scheme will be added probably later.
  10
  11 ![ESP8266 Pinout](https://repository.interplaymedium.org/RGBW%20Controller/esppinout_.png)
  12 ![ESP8266 Programming](https://repository.interplaymedium.org/RGBW%20Controller/usbprogram_.png)
  13
  14 ## Preparing the building environment
  15
  16 Make sure that you have the environment installed as described at
  17
  18 1. [makeEspArduino.mk](https://github.com/plerup/makeEspArduino.git)
  19 2. [esp8266 Arduino SDK](https://github.com/esp8266/Arduino)
  20
  21 3. In the *make* script, change path for each variable approprately:
  22     MAKE_FILE=....
  23     ESP_SDK_ROOT=....
  24
  25 ## Change your IM AXOD microserver or AP (router) WIFI login and password
  26
  27 create the file
  28     vim ../info
  29
  30 assign SSID and PASSWORD of your local IM AXOD microserver or Access Point in there
  31
  32     WIFI_SSID="ssid"
  33     WIFI_PASS="ssid password"
  34
  35 You can change it later whenewer you want using HTTP interface
  36
  37 ## Building
  38
  39 initial buildong and flashing firmware at once
  40
  41     ./make RGBW_Controller upload
  42
  43 after that you may just build the binary and uload it using remote HTTP interface
  44
  45     ./make RGBW_Controller
  46     curl -F image=@RGBW_Controller.bin -s http://im_<....>.lan/update
  47
  48 ## Usage
  49
  50
  51 By default dendrite can be reached "im_rgb5" doman
  52
  53 Change it with
  54
  55     curl "http://im_rgb5?rename=NEWNAME"
  56
  57 Turn on the color and effect
  58
  59     curl "im_rgb5?rgbw=aadd00&rotate=100"
  60
  61 Other options
  62
  63     curl "http://im_rgb5/help"
  64
  65 ## Todo
  66
  67 This firmware is in progress. Here is a brief list of upcoming changes.
  68
  69 * make default URL as IM_(LAST 4 DIGITS OF MAC ADDRESS)
  70 * add interface features (save, reset....)
  71 * state return in 2 variants
  72     txt (default)
  73     JSON
  74 * add commands
  75     switch (like rgbw=00ff0000) for latch switchers
  76     dimm (for dimmer, HW prototype required, 220v)
  77     rgbwdef -- save default values in EEPROM, which is returning on reset command
  78     rotatedef -- same for rotation
  79
  80 * switching AP/slave, AP by defuault
  81     remote access setup (host name, AP/slave, SSID, passw)
  82     save in EEPROM
  83
  84 ## License
  85
  86 Copyright © 2016 Dmitry Shalnov [interplaymedium.org]
  87
  88 Licensed under the Apache License, Version 2.0 (the "License");
  89 you may not use this files except in compliance with the License.
  90 You may obtain a copy of the License at
  91
  92     http://www.apache.org/licenses/LICENSE-2.0
  93
  94 Unless required by applicable law or agreed to in writing, software
  95 distributed under the License is distributed on an "AS IS" BASIS,
  96 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  97 See the License for the specific language governing permissions and
  98 limitations under the License.
  99
 100
 101
 102
 103
 104